From 9e0da6fb206a17b3c1d3b5251ebdc0249b2085bb Mon Sep 17 00:00:00 2001 From: "Carol (Nichols || Goulding)" Date: Fri, 13 May 2016 16:47:11 -0400 Subject: [PATCH] Add instructions for rendering docs locally to the README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ad7556b6..49d73629a 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,14 @@ a list of known community-developed subcommands. ## Contributing to the Docs To contribute to the docs, all you need to do is change the markdown files in -the `src/doc` directory. +the `src/doc` directory. To view the rendered version of changes you have +made locally, run: + +```sh +./configure +make doc +open target/doc/index.html +``` ## Release notes -- 2.30.2